<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-data.Field'>/**
</span> * @author Ed Spencer
 * @class Ext.data.Field
 * @extends Object
 * 
 * &lt;p&gt;Fields are used to define what a Model is. They aren't instantiated directly - instead, when we create a class 
 * that extends {@link Ext.data.Model}, it will automatically create a Field instance for each field configured in a 
 * {@link Ext.data.Model Model}. For example, we might set up a model like this:&lt;/p&gt;
 * 
&lt;pre&gt;&lt;code&gt;
Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: [
        'name', 'email',
        {name: 'age', type: 'int'},
        {name: 'gender', type: 'string', defaultValue: 'Unknown'}
    ]
});
&lt;/code&gt;&lt;/pre&gt;
 * 
 * &lt;p&gt;Four fields will have been created for the User Model - name, email, age and gender. Note that we specified a
 * couple of different formats here; if we only pass in the string name of the field (as with name and email), the
 * field is set up with the 'auto' type. It's as if we'd done this instead:&lt;/p&gt;
 * 
&lt;pre&gt;&lt;code&gt;
Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: [
        {name: 'name', type: 'auto'},
        {name: 'email', type: 'auto'},
        {name: 'age', type: 'int'},
        {name: 'gender', type: 'string', defaultValue: 'Unknown'}
    ]
});
&lt;/code&gt;&lt;/pre&gt;
 * 
 * &lt;p&gt;&lt;u&gt;Types and conversion&lt;/u&gt;&lt;/p&gt;
 * 
 * &lt;p&gt;The {@link #type} is important - it's used to automatically convert data passed to the field into the correct
 * format. In our example above, the name and email fields used the 'auto' type and will just accept anything that is
 * passed into them. The 'age' field had an 'int' type however, so if we passed 25.4 this would be rounded to 25.&lt;/p&gt;
 * 
 * &lt;p&gt;Sometimes a simple type isn't enough, or we want to perform some processing when we load a Field's data. We can
 * do this using a {@link #convert} function. Here, we're going to create a new field based on another:&lt;/p&gt;
 * 
&lt;code&gt;&lt;pre&gt;
Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: [
        'name', 'email',
        {name: 'age', type: 'int'},
        {name: 'gender', type: 'string', defaultValue: 'Unknown'},

        {
            name: 'firstName',
            convert: function(value, record) {
                var fullName  = record.get('name'),
                    splits    = fullName.split(&quot; &quot;),
                    firstName = splits[0];

                return firstName;
            }
        }
    ]
});
&lt;/code&gt;&lt;/pre&gt;
 * 
 * &lt;p&gt;Now when we create a new User, the firstName is populated automatically based on the name:&lt;/p&gt;
 * 
&lt;code&gt;&lt;pre&gt;
var ed = Ext.ModelManager.create({name: 'Ed Spencer'}, 'User');

console.log(ed.get('firstName')); //logs 'Ed', based on our convert function
&lt;/code&gt;&lt;/pre&gt;
 * 
 * &lt;p&gt;In fact, if we log out all of the data inside ed, we'll see this:&lt;/p&gt;
 * 
&lt;code&gt;&lt;pre&gt;
console.log(ed.data);

//outputs this:
{
    age: 0,
    email: &quot;&quot;,
    firstName: &quot;Ed&quot;,
    gender: &quot;Unknown&quot;,
    name: &quot;Ed Spencer&quot;
}
&lt;/code&gt;&lt;/pre&gt;
 * 
 * &lt;p&gt;The age field has been given a default of zero because we made it an int type. As an auto field, email has
 * defaulted to an empty string. When we registered the User model we set gender's {@link #defaultValue} to 'Unknown'
 * so we see that now. Let's correct that and satisfy ourselves that the types work as we expect:&lt;/p&gt;
 * 
&lt;code&gt;&lt;pre&gt;
ed.set('gender', 'Male');
ed.get('gender'); //returns 'Male'

ed.set('age', 25.4);
ed.get('age'); //returns 25 - we wanted an int, not a float, so no decimal places allowed
&lt;/code&gt;&lt;/pre&gt;
 * 
 */
Ext.define('Ext.data.Field', {
    requires: ['Ext.data.Types', 'Ext.data.SortTypes'],
    alias: 'data.field',
    
    constructor : function(config) {
        if (Ext.isString(config)) {
            config = {name: config};
        }
        Ext.apply(this, config);
        
        var types = Ext.data.Types,
            st = this.sortType,
            t;

        if (this.type) {
            if (Ext.isString(this.type)) {
                this.type = types[this.type.toUpperCase()] || types.AUTO;
            }
        } else {
            this.type = types.AUTO;
        }

        // named sortTypes are supported, here we look them up
        if (Ext.isString(st)) {
            this.sortType = Ext.data.SortTypes[st];
        } else if(Ext.isEmpty(st)) {
            this.sortType = this.type.sortType;
        }

        if (!this.convert) {
            this.convert = this.type.convert;
        }
    },
    
<span id='Ext-data.Field-cfg-name'>    /**
</span>     * @cfg {String} name
     * The name by which the field is referenced within the Model. This is referenced by, for example,
     * the &lt;code&gt;dataIndex&lt;/code&gt; property in column definition objects passed to {@link Ext.grid.property.HeaderContainer}.
     * &lt;p&gt;Note: In the simplest case, if no properties other than &lt;code&gt;name&lt;/code&gt; are required, a field
     * definition may consist of just a String for the field name.&lt;/p&gt;
     */
    
<span id='Ext-data.Field-cfg-type'>    /**
</span>     * @cfg {Mixed} type
     * (Optional) The data type for automatic conversion from received data to the &lt;i&gt;stored&lt;/i&gt; value if &lt;code&gt;{@link Ext.data.Field#convert convert}&lt;/code&gt;
     * has not been specified. This may be specified as a string value. Possible values are
     * &lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
     * &lt;li&gt;auto (Default, implies no conversion)&lt;/li&gt;
     * &lt;li&gt;string&lt;/li&gt;
     * &lt;li&gt;int&lt;/li&gt;
     * &lt;li&gt;float&lt;/li&gt;
     * &lt;li&gt;boolean&lt;/li&gt;
     * &lt;li&gt;date&lt;/li&gt;&lt;/ul&gt;&lt;/div&gt;
     * &lt;p&gt;This may also be specified by referencing a member of the {@link Ext.data.Types} class.&lt;/p&gt;
     * &lt;p&gt;Developers may create their own application-specific data types by defining new members of the
     * {@link Ext.data.Types} class.&lt;/p&gt;
     */
    
<span id='Ext-data.Field-cfg-convert'>    /**
</span>     * @cfg {Function} convert
     * (Optional) A function which converts the value provided by the Reader into an object that will be stored
     * in the Model. It is passed the following parameters:&lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
     * &lt;li&gt;&lt;b&gt;v&lt;/b&gt; : Mixed&lt;div class=&quot;sub-desc&quot;&gt;The data value as read by the Reader, if undefined will use
     * the configured &lt;code&gt;{@link Ext.data.Field#defaultValue defaultValue}&lt;/code&gt;.&lt;/div&gt;&lt;/li&gt;
     * &lt;li&gt;&lt;b&gt;rec&lt;/b&gt; : Ext.data.Model&lt;div class=&quot;sub-desc&quot;&gt;The data object containing the Model as read so far by the 
     * Reader. Note that the Model may not be fully populated at this point as the fields are read in the order that 
     * they are defined in your {@link #fields} array.&lt;/div&gt;&lt;/li&gt;
     * &lt;/ul&gt;&lt;/div&gt;
     * &lt;pre&gt;&lt;code&gt;
// example of convert function
function fullName(v, record){
    return record.name.last + ', ' + record.name.first;
}

function location(v, record){
    return !record.city ? '' : (record.city + ', ' + record.state);
}

Ext.define('Dude', {
    extend: 'Ext.data.Model',
    fields: [
        {name: 'fullname',  convert: fullName},
        {name: 'firstname', mapping: 'name.first'},
        {name: 'lastname',  mapping: 'name.last'},
        {name: 'city', defaultValue: 'homeless'},
        'state',
        {name: 'location',  convert: location}
    ]
});

// create the data store
var store = new Ext.data.Store({
    reader: {
        type: 'json',
        model: 'Dude',
        idProperty: 'key',
        root: 'daRoot',
        totalProperty: 'total'
    }
});

var myData = [
    { key: 1,
      name: { first: 'Fat',    last:  'Albert' }
      // notice no city, state provided in data object
    },
    { key: 2,
      name: { first: 'Barney', last:  'Rubble' },
      city: 'Bedrock', state: 'Stoneridge'
    },
    { key: 3,
      name: { first: 'Cliff',  last:  'Claven' },
      city: 'Boston',  state: 'MA'
    }
];
     * &lt;/code&gt;&lt;/pre&gt;
     */
<span id='Ext-data.Field-cfg-dateFormat'>    /**
</span>     * @cfg {String} dateFormat
     * &lt;p&gt;(Optional) Used when converting received data into a Date when the {@link #type} is specified as &lt;code&gt;&quot;date&quot;&lt;/code&gt;.&lt;/p&gt;
     * &lt;p&gt;A format string for the {@link Ext.Date#parse Ext.Date.parse} function, or &quot;timestamp&quot; if the
     * value provided by the Reader is a UNIX timestamp, or &quot;time&quot; if the value provided by the Reader is a
     * javascript millisecond timestamp. See {@link Date}&lt;/p&gt;
     */
    dateFormat: null,
    
<span id='Ext-data.Field-cfg-useNull'>    /**
</span>     * @cfg {Boolean} useNull
     * &lt;p&gt;(Optional) Use when converting received data into a Number type (either int or float). If the value cannot be parsed,
     * null will be used if useNull is true, otherwise the value will be 0. Defaults to &lt;tt&gt;false&lt;/tt&gt;
     */
    useNull: false,
    
<span id='Ext-data.Field-cfg-defaultValue'>    /**
</span>     * @cfg {Mixed} defaultValue
     * (Optional) The default value used &lt;b&gt;when a Model is being created by a {@link Ext.data.reader.Reader Reader}&lt;/b&gt;
     * when the item referenced by the &lt;code&gt;{@link Ext.data.Field#mapping mapping}&lt;/code&gt; does not exist in the data
     * object (i.e. undefined). (defaults to &quot;&quot;)
     */
    defaultValue: &quot;&quot;,
<span id='Ext-data.Field-cfg-mapping'>    /**
</span>     * @cfg {String/Number} mapping
     * &lt;p&gt;(Optional) A path expression for use by the {@link Ext.data.reader.Reader} implementation
     * that is creating the {@link Ext.data.Model Model} to extract the Field value from the data object.
     * If the path expression is the same as the field name, the mapping may be omitted.&lt;/p&gt;
     * &lt;p&gt;The form of the mapping expression depends on the Reader being used.&lt;/p&gt;
     * &lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
     * &lt;li&gt;{@link Ext.data.reader.Json}&lt;div class=&quot;sub-desc&quot;&gt;The mapping is a string containing the javascript
     * expression to reference the data from an element of the data item's {@link Ext.data.reader.Json#root root} Array. Defaults to the field name.&lt;/div&gt;&lt;/li&gt;
     * &lt;li&gt;{@link Ext.data.reader.Xml}&lt;div class=&quot;sub-desc&quot;&gt;The mapping is an {@link Ext.DomQuery} path to the data
     * item relative to the DOM element that represents the {@link Ext.data.reader.Xml#record record}. Defaults to the field name.&lt;/div&gt;&lt;/li&gt;
     * &lt;li&gt;{@link Ext.data.reader.Array}&lt;div class=&quot;sub-desc&quot;&gt;The mapping is a number indicating the Array index
     * of the field's value. Defaults to the field specification's Array position.&lt;/div&gt;&lt;/li&gt;
     * &lt;/ul&gt;&lt;/div&gt;
     * &lt;p&gt;If a more complex value extraction strategy is required, then configure the Field with a {@link #convert}
     * function. This is passed the whole row object, and may interrogate it in whatever way is necessary in order to
     * return the desired data.&lt;/p&gt;
     */
    mapping: null,
<span id='Ext-data.Field-cfg-sortType'>    /**
</span>     * @cfg {Function} sortType
     * (Optional) A function which converts a Field's value to a comparable value in order to ensure
     * correct sort ordering. Predefined functions are provided in {@link Ext.data.SortTypes}. A custom
     * sort example:&lt;pre&gt;&lt;code&gt;
// current sort     after sort we want
// +-+------+          +-+------+
// |1|First |          |1|First |
// |2|Last  |          |3|Second|
// |3|Second|          |2|Last  |
// +-+------+          +-+------+

sortType: function(value) {
   switch (value.toLowerCase()) // native toLowerCase():
   {
      case 'first': return 1;
      case 'second': return 2;
      default: return 3;
   }
}
     * &lt;/code&gt;&lt;/pre&gt;
     */
    sortType : null,
<span id='Ext-data.Field-cfg-sortDir'>    /**
</span>     * @cfg {String} sortDir
     * (Optional) Initial direction to sort (&lt;code&gt;&quot;ASC&quot;&lt;/code&gt; or  &lt;code&gt;&quot;DESC&quot;&lt;/code&gt;).  Defaults to
     * &lt;code&gt;&quot;ASC&quot;&lt;/code&gt;.
     */
    sortDir : &quot;ASC&quot;,
<span id='Ext-data.Field-cfg-allowBlank'>    /**
</span>     * @cfg {Boolean} allowBlank
     * @private
     * (Optional) Used for validating a {@link Ext.data.Model model}, defaults to &lt;code&gt;true&lt;/code&gt;.
     * An empty value here will cause {@link Ext.data.Model}.{@link Ext.data.Model#isValid isValid}
     * to evaluate to &lt;code&gt;false&lt;/code&gt;.
     */
    allowBlank : true,
    
<span id='Ext-data.Field-cfg-persist'>    /**
</span>     * @cfg {Boolean} persist
     * False to exclude this field from the {@link Ext.data.Model#modified} fields in a model. This 
     * will also exclude the field from being written using a {@link Ext.data.writer.Writer}. This option
     * is useful when model fields are used to keep state on the client but do not need to be persisted
     * to the server. Defaults to &lt;tt&gt;true&lt;/tt&gt;.
     */
    persist: true
});
</pre></pre></body></html>